XIQS Get Topup List

From IQsimWiki

Jump to: navigation, search

XIQS Get Topup List - Topup Management

Description
getXIQSTopupList ( [ Long id_partition ] , [ filter f ] )
Get a list of Topup Codes. In the case the current logged user is administrator, he may specify which partition Topup Code he is interested by.
Parameters

[ Long id_partition ]

Partition Id

[ filter f ]

Return Values
List
Long id - Topup Code Id

String voucher - Voucher code

Long peak - SIM Call Peak (mn) value to recharge

Long offpeak - SIM Call Off Peak (mn) value to recharge

Long bonus - SIM Call Bonus (mn) value to recharge

Long smspeak - SIM SMS Peak value to recharge

Long smsoffpk - SIM SMS Off Peak value to recharge

Long smsbonus - SIM SMS Bonus value to recharge

String iccid - SIM cards ICCID

Integer status - Voucher Status:
0 - Not yet used
1 - Used and successful
2 - Reserved
3 - Used but error

Integer gsmerror - Error code received from GSM module:
0 - OK
1 - ERROR
2 - TIMEOUT
3 - Transaction already in progress
4 - Port NOT REGISTERED
5 - Invalid Transaction Command
6 - Invalid ICCID
7 - Invalid Slot Number
8 - Invalid Port Number
9 - Error sending USSD/SMS/CALL command
10 - Module switched off
11 - USSD Call Tranascation Canceled Current Voice Call hanged up
13 - USSD Canceled SET SIM received from SIM server
14 - USSD not supported
15 - First SMS returned but Second SMS missing if TF_TWO_SMS_NEEDED
16 - First SMS returned but Second SMS too long to fit in messge answer
17 - Time out during delivery report
18 - Time out on first SMS returned
19 - CUSD answer other local client has responded
20 - CUSD answer operation not supported
21 - CUSD answer network time out

Long useddate - Used date (in seconds since 01/01/1970))

String phonenum - Phone number that used this Voucher

Long transfercredit - Amount to decrease from transfer SIM card

Long id_partition - Partition Id

Long id_priceplan - Price Plan Id

String ppname - Price Plan Name

String comment - Topup comment

Error Data structure ( Error Management )

Possible failure code returns
*ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB
See Also

createXIQSTopup

importXIQSTopup

updateXIQSTopup

deleteXIQSTopup

resetXIQSTopupList

Personal tools
Namespaces
Variants
Views
Actions
Navigation
XIQS XML Protocol
XIQS Framework Libraries
XIQS Command List